This is a lower-level API. Lower-level APIs are not recommended for most projects, and may not be available on all plans. See our page on recommended deployment patterns for more information.
Initialization Option Question Editor API

[metadataKey]

Examples

custom_metadata: {
    custom_metadata_key: {
        description: 'custom metadata description',
        name: 'custom metadata name',
        type: 'string'
    }
}

Values

Request object key custom_metadata.[metadataKey]

Type object

This object has the following properties which can be configured.

  • description string

    A description of the metadata to be captured.

  • name string

    The title of the metadata field as you want it to appear in the editor.

  • type string

    The type of input to be displayed to the user; a value of "string" will render a basic text input, and a value of "editor" will render a rich text editor, "arrayEditors" will render an array of rich text editors.

Was this article helpful?